Skip to main content
Version: 5.3.0.0

Runtime

Group "Runtime"​

General Node Settings​

These settings must be configured for all types of Orchestra installations.

language​

Defines the default language of the current Orchestra node.

mode​

Defines the operation mode of the current Orchestra node:

  1. STANDALONE - No communication with other Orchestra installations; standard mode.

  2. CLUSTERNODE - All installations of a cluster use the same database, providing security in case one installation crashes.

nodeid​

Defines the unique name of this node within a cell. The unique identifier is the combination of cellname and nodeid. Only letters, digits, and '-' are allowed. The maximum length must not exceed 10 characters.

label​

Defines a comma-separated list of tags associated with the current node. Examples of tags include "TEST", "PRODUCTION", "MASTERDATA", or "PROD,QS,PERSON". This field can be used within the recipient-list pattern to send signals only to nodes of a specified type.

cellname​

Specifies the name of the owning cell, which must be unique (two cells cannot have the same cellname).

cell.type​

Defines a user/installation-specific type of the node. Examples include "TEST", "PRODUCTION", or "MASTERDATA". This field may also be utilized within the recipient-list pattern to send signals only to nodes of a specified type.

deploy.path​

Temporary directory used during the deployment of scenario elements.

maxMemoryUsage​

Defines a threshold (in percent) for memory consumption. If memory usage exceeds this threshold, Orchestra will force subsystems to store newly created objects in the database. This behavior will cease once the memory situation normalizes. Allowed values range from 50 to 100.

note

The maximum available memory is defined by the global virtual machine settings.

Parameters For Cluster Environment​

These settings are applicable only for Orchestra operating in cluster mode.

node.ip​

Defines the IP address of this cluster node.

node.port​

Defines the port used for the inter-cluster-node protocol.

node.heartbeat​

Defines the time interval (in seconds) used to monitor the availability of cluster nodes.

loadbalancing​

Defines the load-balancing behavior between Orchestra instances in cluster mode. This parameter is only valid in cluster mode.

  • yes: Orchestra performs automatic load balancing of processes.

  • no: Load-balancing is disabled.

fifoloadbalancing​

Defines load-balancing behavior for FIFO-scheduled processes. This parameter has no effect if load-balancing is disabled overall. Otherwise, the following settings apply:

  • yes: Load-balancing of FIFO-scheduled processes.

  • no: Only best-effort processes are load-balanced.

clusterswitch​

Defines the error behavior when a cluster node crashes:

  • on: All persistent processes switch automatically to an available node when a node crashes.

  • off: Orchestra does not perform cluster switches.

cluster.channel.check​

Specifies the timespan (in seconds) for how often the system checks if all channels are distributed as expected.

cluster.channel.errorDelay​

Defines the delay time after an error before a new check is performed.

cluster.channel.maxErrorCount​

Defines the maximum number of retries before a channel-distribution check is aborted.

cluster.compute.overview​

If set to true, Orchestra computes the process overview for an inactive node over the database; otherwise, the overview is considered undefined.

cluster.defaultParameterHandling​

Defines whether parameters that do not set the clusterGlobal attribute should be used as local or global parameters.

cluster.timout​

Defines the timeout (in milliseconds) for TCP communication between cluster nodes.

Parameters For Cell Communication​

These settings are required if Orchestra is used for cell communication.

local.port​

Defines the local TCP/IP port where the cell waits for incoming requests (ingoing port).

poolsize​

Defines the number of worker threads responsible for processing cell messages.

cell.certificatecheck​

Defines whether an additional certificate check is required when creating a cell connection. If set to false, only password-based authentication is used.

cell.connect.timeout​

Defines the maximum time allowed for establishing a cell connection before aborting with a timeout.

cell.ping.intervall​

Defines the interval for sending keep-alive messages to a remote cell.

cell.public.endpoint​

The public name or IP address that can be used to reach this Orchestra from external sources.

cell.send.timeout​

Defines the timeout for send operations. An exception is thrown if a sender cannot acquire access to a cell connection within this timeout.

Configuration of Cells That Are Allowed to Send Messages to This Cell​

Ensure that you uncomment the ingoing and outgoing sections in the file.

ingoing​

A comma-separated list of all cells connected to this server; it is case-sensitive. In earlier versions, these were node IDs. In more recent versions, this list consists of aliases. For each peer, the following entries must be maintained. <name> is the cell name included in this list.

peer.ingoing.<name>.endpoint​

TCP/IP address or hostname of the remote peer.

peer.ingoing.<name>.password​

Password for authentication of the remote peer; the passwords of sending and receiving cells must match.

peer.ingoing.<name>.cell​

The name of the owning cell, configured as the cellname.

peer.ingoing.<name>.nodeName​

The name of the node contained in this cell, configured as the node ID.

Configuration of Cells That This Cell Sends Messages To​

outgoing​

A comma-separated list of all cells connected to this server; it is case-sensitive. In earlier versions, these were node IDs. In more recent versions, this list consists of aliases. For each peer, the following entries must be maintained. <name> is the cell name included in this list.

peer.outgoing.<name>.endpoint​

TCP/IP address or hostname of the remote peer.

peer.outgoing.<name>.password​

Password for authentication of the remote peer.

peer.outgoing.<name>.port​

Accept port of the remote cell.

peer.outgoing.<name>.cell​

The name of the owning cell, configured as the cellname.

peer.outgoing.<name>.nodeName​

The name of the node contained in this cell, configured as the node ID.

Routing Configuration​

This section includes all cells that have no direct link to the current Orchestra cell but can be reached via routing through one or more Orchestra cells.

hopcount​

Defines the maximum number of intermediate cells that a packet can "hop" before being discarded. This helps prevent infinite loops in the routing tables.

routed​

A comma-separated list of all cells reachable through cell routing. This list contains the cell names. For each peer, the following entry must be maintained.

target.<name>.router​

Defines the next router responsible for sending packets with the target <name> to the destination (this is the next hop).

Parameters For Autodeployment​

The Autodeployment service facilitates configuring Orchestra instances without any Monitor interaction using a web browser. Refer to Headless Configuration for details.

autodeployment.dir​

The directory to scan for scenario files to be deployed and credentials or landscapes to be uploaded.

autodeployment.activate​

If true, scenarios are activated after successful deployment of the files.

autodeployment.activate.async​

Defines whether scenario activation should be done asynchronously (=true) or synchronously (=false).

autodeployment.generate.docu​

Defines whether the documentation should be updated during auto deployment (=true) or not (=false).

autodeployment.mode​

Completion mode: external extends the filename with .wrk -> .ok/.err; internal mode stores the state in the database.

autodeployment.polling​

The polling period in seconds; only used in external mode.

autodeployment.recursive​

If true, subdirectories will also be scanned for files to deploy/upload.

allow.access.to.internal.db​

If set to true, it allows the use of an environment entry database connection to access the internal database.

Other Options​

These settings must be configured for all types of Orchestra installations.

containerMode​

Container mode defines whether Orchestra operates in container mode or not.

deploy.path​

Temporary directory used during the deployment of scenario elements.

environment.backup​

This is the path (on the server running the monitor) where a backup of all modified groups (including the old values) will be saved if a user changes anything.

external.config.dir​

During the startup of Orchestra, the system scans for configuration files in a folder defined in the environment_settings.xml file.

external.monitor.url​

Defines the base URL used for accessing the Orchestra monitor externally (e.g., https://<hostname>:<port>).

fifoloadbalancing​

Defines load-balancing behavior for FIFO-scheduled processes. If load-balancing is generally disabled, this parameter has no effect. Otherwise, the following settings apply:

  • yes: Load-balancing of FIFO-scheduled processes.

  • no: Only best-effort processes are load-balanced.

kpi.persistence.enabled​

Defines whether KPI data are stored persistently (=true) or kept in memory only (=false).